GNSS 9 Click Driver

API for configuring and manipulating GNSS 9 Click driver. More...

Topics
	GNSS 9 Device Settings
	Settings for registers of GNSS 9 Click driver.
	GNSS 9 MikroBUS Map
	MikroBUS pin mapping of GNSS 9 Click driver.

Functions
void	gnss9_cfg_setup (gnss9_cfg_t *cfg)
	GNSS 9 configuration object setup function.
void	gnss9_drv_interface_selection (gnss9_cfg_t *cfg, gnss9_drv_t drv_sel)
	GNSS 9 driver interface setup function.
err_t	gnss9_init (gnss9_t *ctx, gnss9_cfg_t *cfg)
	GNSS 9 initialization function.
err_t	gnss9_generic_write (gnss9_t *ctx, uint8_t *data_in, uint8_t len)
	GNSS 9 data writing function.
err_t	gnss9_generic_read (gnss9_t *ctx, uint8_t *data_out, uint8_t len)
	GNSS 9 data reading function.
void	gnss9_set_rst_pin (gnss9_t *ctx, uint8_t state)
	GNSS 9 set RST pin function.
void	gnss9_set_wup_pin (gnss9_t *ctx, uint8_t state)
	GNSS 9 set WUP pin function.
uint8_t	gnss9_get_pps_pin (gnss9_t *ctx)
	GNSS 9 get PPS pin function.
void	gnss9_reset_device (gnss9_t *ctx)
	GNSS 9 reset device function.
err_t	gnss9_parse_gpgga (uint8_t *rsp_buf, uint8_t gpgga_element, uint8_t *element_data)
	GNSS 9 parse GPGGA function.

Detailed Description

API for configuring and manipulating GNSS 9 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

gnss9_cfg_setup()

void gnss9_cfg_setup

(

gnss9_cfg_t *

cfg

)

GNSS 9 configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See gnss9_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

gnss9_drv_interface_selection()

void gnss9_drv_interface_selection	(	gnss9_cfg_t *	cfg,
		gnss9_drv_t	drv_sel )

GNSS 9 driver interface setup function.

This function sets a serial driver interface which will be used further in the Click driver.

Parameters

[out]	cfg	: Click configuration structure. See gnss9_cfg_t object definition for detailed explanation.
[in]	drv_sel	: Driver interface selection. See gnss9_drv_t object definition for detailed explanation.

Returns

Nothing.

Note

This driver selection should be call before init function to configure the driver to work with the serial interface which is consistent with the real state of the hardware. If this function is not called, the default driver interface will be set.

gnss9_generic_read()

err_t gnss9_generic_read	(	gnss9_t *	ctx,
		uint8_t *	data_out,
		uint8_t	len )

GNSS 9 data reading function.

This function reads a desired number of data bytes from the module.

Parameters

[in]	ctx	: Click context object. See gnss9_t object definition for detailed explanation.
[out]	data_out	: Output read data.
[in]	len	: Number of bytes to be read.

Returns

• >=0 - Success, or number of data bytes read in the case of UART,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

gnss9_generic_write()

err_t gnss9_generic_write	(	gnss9_t *	ctx,
		uint8_t *	data_in,
		uint8_t	len )

GNSS 9 data writing function.

This function writes a desired number of data bytes to the module.

Parameters

[in]	ctx	: Click context object. See gnss9_t object definition for detailed explanation.
[in]	data_in	: Data to be written.
[in]	len	: Number of bytes to be written.

Returns

• >=0 - Success, or number of data bytes written in the case of UART,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

gnss9_get_pps_pin()

uint8_t gnss9_get_pps_pin

(

gnss9_t *

ctx

)

GNSS 9 get PPS pin function.

This function returns the PPS pin logic state.

Parameters

[in]

ctx

: Click context object. See gnss9_t object definition for detailed explanation.

Returns

Pin logic state.

Note

None.

gnss9_init()

err_t gnss9_init	(	gnss9_t *	ctx,
		gnss9_cfg_t *	cfg )

GNSS 9 initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters

[out]	ctx	: Click context object. See gnss9_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See gnss9_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

gnss9_parse_gpgga()

err_t gnss9_parse_gpgga	(	uint8_t *	rsp_buf,
		uint8_t	gpgga_element,
		uint8_t *	element_data )

GNSS 9 parse GPGGA function.

This function parses the GPGGA data from the read response buffer.

Parameters

[in]	rsp_buf	: Response buffer.
[in]	gpgga_element	: GPGGA element position [1-14].
[out]	element_data	: Element data parsed.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

gnss9_reset_device()

void gnss9_reset_device

(

gnss9_t *

ctx

)

GNSS 9 reset device function.

This function resets the device by toggling the RST pin.

Parameters

[in]

ctx

: Click context object. See gnss9_t object definition for detailed explanation.

Returns

None.

Note

None.

gnss9_set_rst_pin()

void gnss9_set_rst_pin	(	gnss9_t *	ctx,
		uint8_t	state )

GNSS 9 set RST pin function.

This function sets the RST pin logic state.

Parameters

[in]	ctx	: Click context object. See gnss9_t object definition for detailed explanation.
[in]	state	: Pin logic state.

Returns

None.

Note

None.

gnss9_set_wup_pin()

void gnss9_set_wup_pin	(	gnss9_t *	ctx,
		uint8_t	state )

GNSS 9 set WUP pin function.

GNSS 9 set AON pin function.

This function sets the WUP pin logic state.

Parameters

[in]	ctx	: Click context object. See gnss9_t object definition for detailed explanation.
[in]	state	: Pin logic state.

Returns

None.

Note

None.

This function sets the AON pin logic state.

Parameters

[in]	ctx	: Click context object. See gnss9_t object definition for detailed explanation.
[in]	state	: Pin logic state.

Returns

None.

Note

None.